スケジュールされたメンテナンス Cmdlets
次に、イベント メンテナンスをスケジュールするコマンドの一覧を示します。
太字の引数は必須です。
Disable-AmcSchedule
メンテナンス スケジュールを無効にします。
戻り値:Void
| 引数 | 引数の説明 |
|---|---|
| JobId (String) | 無効にするジョブの数値 ID。 |
Enable-AmcSchedule
メンテナンス スケジュールを有効にします。
戻り値:Void
| 引数 | 引数の説明 |
|---|---|
| JobId (String) | 有効にするジョブの数値 ID。 |
Get-AmcSchedule
JobId から単一のスケジュールされたメンテナンスを取得します。
戻り値:MaintenanceHelper.SchedulesDto
| 引数 | 引数の説明 |
|---|---|
| JobId (String) | 取得するジョブの数値 ID。 |
Invoke-AmcRemoveEventsFromDeploymentGroup
指定された配布グループからイベントを削除します。
スケジュールの呼び出しを実行すると、指定したタイプの一時スケジュールが作成されます。このスケジュールはただちに実行され、その後自動的に削除されます。
戻り値:Void
| 引数 | 引数の説明 |
|---|---|
| GroupName (String) | イベントが削除される配布グループの名前。 |
|
BatchDelay |
トランザクションが処理できるように SQL を一時停止する時間 (ミリ秒)。 |
|
BatchSize |
各バッチ処理内で影響を受ける行数。 |
Invoke-AmcRemoveEventsOlderThan
指定された日数よりも古いイベントを削除します。
スケジュールの呼び出しを実行すると、指定したタイプの一時スケジュールが作成されます。このスケジュールはただちに実行され、その後自動的に削除されます。
戻り値:Void
| 引数 | 引数の説明 |
|---|---|
| Days (String) | イベントを保持する日数。この日数よりも古いすべてのイベントは削除されます。 |
|
BatchDelay |
トランザクションが処理できるように SQL を一時停止する時間 (ミリ秒)。 |
|
BatchSize |
各バッチ処理内で影響を受ける行数。 |
Invoke-AmcRemoveEventsWithId
指定された ID のイベントを削除します。
スケジュールの呼び出しを実行すると、指定したタイプの一時スケジュールが作成されます。このスケジュールはただちに実行され、その後自動的に削除されます。
戻り値:Void
| 引数 | 引数の説明 |
|---|---|
| EventId (String) | データベースから削除されるイベント ID。 |
|
BatchDelay |
トランザクションが処理できるように SQL を一時停止する時間 (ミリ秒)。 |
|
BatchSize |
各バッチ処理内で影響を受ける行数。 |
Invoke-AmcRemoveEventsWithIdRange
イベント ID 範囲のすべてのイベントを削除します。
スケジュールの呼び出しを実行すると、指定したタイプの一時スケジュールが作成されます。このスケジュールはただちに実行され、その後自動的に削除されます。
戻り値:Void
| 引数 | 引数の説明 |
|---|---|
| End Event Id (String) | 範囲の最後のイベント ID。 |
|
Start Event Id |
範囲の最初のイベント ID。 |
|
BatchDelay |
トランザクションが処理できるように SQL を一時停止する時間 (ミリ秒)。 |
|
BatchSize |
各バッチ処理内で影響を受ける行数。 |
Invoke-AmcRemovehighVolumeEventsOlderThan
指定された日数よりも古いすべての量の大きいイベントを削除します。
スケジュールの呼び出しを実行すると、指定したタイプの一時スケジュールが作成されます。このスケジュールはただちに実行され、その後自動的に削除されます。
戻り値:Void
| 引数 | 引数の説明 |
|---|---|
| Days (String) | 大量のイベントを保持する最大期間。 |
|
BatchDelay |
トランザクションが処理できるように SQL を一時停止する時間 (ミリ秒)。 |
|
BatchSize |
各バッチ処理内で影響を受ける行数。 |
Invoke-AmcRemoveOrphanedAlerts
関連付けられたイベントがないすべてのアラートを削除します。
スケジュールの呼び出しを実行すると、指定したタイプの一時スケジュールが作成されます。このスケジュールはただちに実行され、その後自動的に削除されます。
戻り値:Void
| 引数 | 引数の説明 |
|---|---|
|
BatchDelay |
トランザクションが処理できるように SQL を一時停止する時間 (ミリ秒)。 |
|
BatchSize |
各バッチ処理内で影響を受ける行数。 |
Remove-AmcSchedule
指定されたジョブ ID のスケジュールを削除します。
戻り値:Void
| 引数 | 引数の説明 |
|---|---|
| JobId (String) | 削除するジョブの数値 ID。Get-AmcSchedules で指定されます。 |
Set-AmcEncryptionKeyHash
AMC 暗号鍵ハッシュを生成します。このハッシュを使用して、データベースに認証資格情報を保存するために使用される暗号鍵を監視します。
戻り値:Void
| 引数 | 引数の説明 |
|---|---|
| 認証資格情報の構成 | データベースを変更するために cmdlet が使用する認証資格情報。このパラメータが省略される場合、cmdlet はユーザの認証資格情報を使用します。 |
| Configurer Sql Authentication (Switch) | このスイッチが指定されると、認証資格情報の構成で提供された資格情報が SQL 認証の資格情報として定義されます。このパラメータが省略される場合、認証資格情報の構成は Windows 認証資格情報を使用します。 |
| データベース サーバ | データベースをホストする SQL サーバ。 |
| データベース名 | SQL Server のデータベース名。 |
Stop-AmcSchedule
指定されたスケジュールをキャンセルします。
戻り値:Void
| 引数 | 引数の説明 |
|---|---|
| JobId (String) | キャンセルするジョブの数値 ID。 |
New-AmcScheduleRemoveEventsFromDeploymentGroup
毎週指定された日に、指定された配布グループからイベントを削除するための新しいスケジュールを追加します。
戻り値:Void
| 引数 | 引数の説明 |
|---|---|
| GroupName (String) | イベントが削除される配布グループの名前。 |
| Description (String) | 管理者がこのスケジュールされたエントリの目的、または任意の詳細情報を指定するフリーテキスト フィールド。 |
| DayOfWeek (DayOfWeek) | 毎週、処理が実行される曜日。値の範囲は0 (日曜日) ～6 (土曜日) までです。 |
| StartTimeInUTC (String) | 要求された処理が開始する UTC 時間を表す文字列。.Net System.DateTime 値に解析できる必要があります。 |
| MaxRunHours (Int) | 処理が実行される時間。ジョブの開始が遅れている場合でも (例:ジョブの開始が遅れている (コンピュータの電源がオフの場合など) でも、完了時刻は常に StartTimeInUTC + MaxRunHours です。 |
| BatchSize (Int) | 各バッチ処理内で影響を受ける行数。 |
| BatchDelay (TimeSpan) | トランザクション ロックを防止するために、トランザクションが処理できるように SQL を一時停止する時間 (秒)。 |
New-AmcScheduleRemoveEventsOlderThan
新しいスケジュールを追加して、指定された日数よりも古いイベントを削除します。
戻り値:Void
|
引数 |
引数の説明 |
|---|---|
|
Days (Int) |
イベントを保持する最大期間。 |
|
Description (String) |
管理者がこのスケジュールされたエントリの目的、または任意の詳細情報を指定するフリーテキスト フィールド。 |
|
DayOfWeek (DayOfWeek) |
毎週、処理が実行される曜日。値の範囲は0 (日曜日) ～6 (土曜日) までです。 |
|
StartTimeInUTC (String) |
要求された処理が開始する UTC 時間を表す文字列。.Net System.DateTime 値に解析できる必要があります。 |
|
MaxRunHours (Int) |
処理が実行される時間。ジョブの開始が遅れている場合でも (例:ジョブの開始が遅れている (コンピュータの電源がオフの場合など) でも、完了時刻は常に StartTimeInUTC + MaxRunHours です。 |
|
BatchSize (Int) |
各バッチ処理内で影響を受ける行数。 |
|
BatchDelay (TimeSpan) |
トランザクション ロックを防止するために、トランザクションが処理できるように SQL を一時停止する時間 (秒)。 |
New-AmcScheduleRemoveEventsWithId
ジョブ スケジュール エントリを作成し、指定された ID のすべてのイベントを削除します。
戻り値:Void
| 引数 | 引数の説明 |
|---|---|
| EventId (Int) | 削除されるイベントのイベント ログ数値 ID。 |
| Description (String) | 管理者がこのスケジュールされたエントリの目的、または任意の詳細情報を指定するフリーテキスト フィールド。 |
| DayOfWeek (DayOfWeek) | 毎週、処理が実行される曜日。値の範囲は0 (日曜日) ～6 (土曜日) までです。 |
| StartTimeInUTC (String) | 要求された処理が開始する UTC 時間を表す文字列。.Net System.DateTime 値に解析できる必要があります。 |
| MaxRunHours (Int) | 処理が実行される時間。ジョブの開始が遅れている場合でも (例:ジョブの開始が遅れている (コンピュータの電源がオフの場合など) でも、完了時刻は常に StartTimeInUTC + MaxRunHours です。 |
| BatchSize (Int) | 各バッチ処理内で影響を受ける行数。 |
| BatchDelay (TimeSpan) | トランザクション ロックを防止するために、トランザクションが処理できるように SQL を一時停止する時間 (秒)。 |
New-AmcScheduleRemoveEventsWithIdRange
毎週指定された日に、すべての配布グループから特定の範囲の値のイベントを削除するための新しいスケジュールを追加します。
戻り値:Void
| 引数 | 引数の説明 |
|---|---|
| StartEventId (Int) | 削除される値範囲の開始のイベント ログ数値 ID。 |
| EndEventId (Int) | 削除される値範囲の終了のイベント ログ数値 ID。 |
| Description (String) | 管理者がこのスケジュールされたエントリの目的、または任意の詳細情報を指定するフリーテキスト フィールド。 |
| DayOfWeek (DayOfWeek) | 毎週、処理が実行される曜日。値の範囲は0 (日曜日) ～6 (土曜日) までです。 |
| StartTimeInUTC (String) | 要求された処理が開始する UTC 時間を表す文字列。.Net System.DateTime 値に解析できる必要があります。 |
| MaxRunHours (Int) | 処理が実行される時間。ジョブの開始が遅れている場合でも (例:ジョブの開始が遅れている (コンピュータの電源がオフの場合など) でも、完了時刻は常に StartTimeInUTC + MaxRunHours です。 |
| BatchSize (Int) | 各バッチ処理内で影響を受ける行数。 |
| BatchDelay (TimeSpan) | トランザクション ロックを防止するために、トランザクションが処理できるように SQL を一時停止する時間 (秒)。 |
New-AmcScheduleRemoveHighVolumeEventsOlderThan
新しいスケジュールを追加して、指定された日数よりも古いすべての大量のイベントを削除します。
戻り値:Void
|
引数 |
引数の説明 |
|---|---|
|
Days (Int) |
イベントを保持する最大期間。 |
|
Description (String) |
管理者がこのスケジュールされたエントリの目的、または任意の詳細情報を指定するフリーテキスト フィールド。 |
|
DayOfWeek (DayOfWeek) |
毎週、処理が実行される曜日。値の範囲は0 (日曜日) ～6 (土曜日) までです。 |
|
StartTimeInUTC (String) |
要求された処理が開始する UTC 時間を表す文字列。.Net System.DateTime 値に解析できる必要があります。 |
|
MaxRunHours (Int) |
処理が実行される時間。ジョブの開始が遅れている場合でも (例:ジョブの開始が遅れている (コンピュータの電源がオフの場合など) でも、完了時刻は常に StartTimeInUTC + MaxRunHours です。 |
|
BatchSize (Int) |
各バッチ処理内で影響を受ける行数。 |
|
BatchDelay (TimeSpan) |
トランザクション ロックを防止するために、トランザクションが処理できるように SQL を一時停止する時間 (秒)。 |
New-AmcScheduleRemoveOrphanedAlerts
関連付けられたイベントがないすべてのアラートを削除するための新しいスケジュールを追加します。
戻り値:Void
| 引数 | 引数の説明 |
|---|---|
| Description (String) | 管理者がこのスケジュールされたエントリの目的、または任意の詳細情報を指定するフリーテキスト フィールド。 |
| DayOfWeek (DayOfWeek) | 毎週、処理が実行される曜日。値の範囲は0 (日曜日) ～6 (土曜日) までです。 |
| StartTimeInUTC (String) | 要求された処理が開始する UTC 時間を表す文字列。.Net System.DateTime 値に解析できる必要があります。 |
| MaxRunHours (Int) | 処理が実行される時間。ジョブの開始が遅れている場合でも (例:ジョブの開始が遅れている (コンピュータの電源がオフの場合など) でも、完了時刻は常に StartTimeInUTC + MaxRunHours です。 |
| BatchSize (Int) | 各バッチ処理内で影響を受ける行数。 |
| BatchDelay (TimeSpan) | トランザクション ロックを防止するために、トランザクションが処理できるように SQL を一時停止する時間 (秒)。 |
Publish-AmcEncryptionKey
AMC は暗号化鍵を使用して、クライアント アクセス認証資格情報などの機密情報を AMC データベースに安全に保存します。複数のサーバが同じデータベースから読み取れるように、この鍵は同期する必要があります。
このコマンドは、他の管理サーバが同期する接続されているデータベースに、ローカル AMC 暗号鍵をプッシュします。
Sync-AmcEncryptionKey コマンドを使用して、他のサーバーでこの鍵を同期することができます。これは指定されたパラメータで暗号化され、データベースに保存されます。すべてのサーバが同期されているときには、Unpublish-AmcEncryptionKey を使用して削除してください。
戻り値:Void
| 引数 | 引数の説明 |
|---|---|
| Password (String) | パスワードを使用して、データベースに保存されている認証資格情報を保護します。別のサーバへの鍵を取得するには、同じパスワードが必要です。 |
| Secure Password (String) | パスワードを使用して、データベースに保存されている認証資格情報を保護します。別のサーバへの鍵を取得するには、同じパスワードが必要です。 |
| 認証資格情報の構成 | データベースを変更するために cmdlet が使用する認証資格情報。このパラメータが省略される場合、cmdlet はユーザの認証資格情報を使用します。 |
| Configurer Sql Authentication (Switch) | このスイッチが指定されると、認証資格情報の構成で提供された資格情報が SQL 認証の資格情報として定義されます。このパラメータが省略される場合、認証資格情報の構成は Windows 認証資格情報を使用します。 |
| データベース サーバ | データベースをホストする SQL サーバ。 |
| データベース名 | SQL Server のデータベース名。 |
Sync-AmcEncryptionKey
AMC は暗号化鍵を使用して、クライアント アクセス認証資格情報などの機密情報を AMC データベースに安全に保存します。複数のサーバが同じデータベースから読み取れるように、この鍵は同期する必要があります。
このコマンドは AMC データベースから保存された暗号鍵を取得し、ローカル サーバで使用します。Publish-AmcEncryptionKey コマンドを使用して、別のサーバから鍵を公開することができます。すべてのサーバが同期されているときには、Unpublish-AmcEncryptionKey を使用してこの鍵を削除してください。
戻り値:Void
| 引数 | 引数の説明 |
|---|---|
| Password (String) | パスワードを使用して、データベースの暗号化鍵を読み取ります。Publish コマンドで使用されたものと同じパスワードを使用する必要があります。 |
| Secure Password (String) | パスワードを使用して、データベースの暗号化鍵を読み取ります。Publish コマンドで使用されたものと同じパスワードを使用する必要があります。 |
| 認証資格情報の構成 | データベースを変更するために cmdlet が使用する認証資格情報。このパラメータが省略される場合、cmdlet はユーザの認証資格情報を使用します。 |
| Configurer Sql Authentication (Switch) | このスイッチが指定されると、認証資格情報の構成で提供された資格情報が SQL 認証の資格情報として定義されます。このパラメータが省略される場合、認証資格情報の構成は Windows 認証資格情報を使用します。 |
| データベース サーバ | データベースをホストする SQL サーバ。 |
| データベース名 | SQL Server のデータベース名。 |
Unpublish-AmcEncyptionKey
AMC は暗号化鍵を使用して、クライアント アクセス認証資格情報などの機密情報を AMC データベースに安全に保存します。複数のサーバが同じデータベースから読み取れるように、この鍵は同期する必要があります。
このコマンドは、他の管理サーバが同期した後に、接続されているデータベースから、AMC 暗号鍵を削除します。鍵は各サーバに安全に保存されますが、データベースには存在しません。
戻り値:Void
| 引数 | 引数の説明 |
|---|---|
| 認証資格情報の構成 | データベースを変更するために cmdlet が使用する認証資格情報。このパラメータが省略される場合、cmdlet はユーザの認証資格情報を使用します。 |
| Configurer Sql Authentication (Switch) | このスイッチが指定されると、認証資格情報の構成で提供された資格情報が SQL 認証の資格情報として定義されます。このパラメータが省略される場合、認証資格情報の構成は Windows 認証資格情報を使用します。 |
| データベース サーバ | データベースをホストする SQL サーバ。 |
| データベース名 | SQL Server のデータベース名。 |
Test-AmcEncryptionKey
AMC は暗号化鍵を使用して、クライアント アクセス認証資格情報などの機密情報を AMC データベースに安全に保存します。複数のサーバが同じデータベースから読み取れるように、この鍵は同期する必要があります。
すべてのサーバを同期している間には、鍵をデータベースに保存できます。このコマンドは、鍵が使用可能かどうかをテストします。
戻り値:Void
| 引数 | 引数の説明 |
|---|---|
| 認証資格情報の構成 | データベースを変更するために cmdlet が使用する認証資格情報。このパラメータが省略される場合、cmdlet はユーザの認証資格情報を使用します。 |
| Configurer Sql Authentication (Switch) | このスイッチが指定されると、認証資格情報の構成で提供された資格情報が SQL 認証の資格情報として定義されます。このパラメータが省略される場合、認証資格情報の構成は Windows 認証資格情報を使用します。 |
| データベース サーバ | データベースをホストする SQL サーバ。 |
| データベース名 | SQL Server のデータベース名。 |
Test-AmcEncryptionKeyHash
ハッシュと暗号鍵を比較します。ハッシュが存在しない場合は、作成されます。コマンドが偽を返す場合は、暗号鍵が変更され、データベースに保存されたクライアント認証資格情報が使用可能になります。
戻り値:Void
| 引数 | 引数の説明 |
|---|---|
| 認証資格情報の構成 | データベースを変更するために cmdlet が使用する認証資格情報。このパラメータが省略される場合、cmdlet はユーザの認証資格情報を使用します。 |
| Configurer Sql Authentication (Switch) | このスイッチが指定されると、認証資格情報の構成で提供された資格情報が SQL 認証の資格情報として定義されます。このパラメータが省略される場合、認証資格情報の構成は Windows 認証資格情報を使用します。 |
| データベース サーバ | データベースをホストする SQL サーバ。 |
| データベース名 | SQL Server のデータベース名。 |
Test-AmcRemoveEventsFromDeploymentGroup
指定された配布グループから削除するイベント数を返します。
戻り値:Void
| 引数 | 引数の説明 |
|---|---|
|
Group Name (String) |
イベントが削除される配布グループの名前。 |
|
BatchDelay |
トランザクションが処理できるように SQL を一時停止する時間 (ミリ秒)。 |
|
BatchSize |
各バッチ処理内で影響を受ける行数。 |
Test-AmcRemoveEventsOlderThan
指定された日数よりも古い、削除される数をイベント数を返します。
戻り値:Void
| 引数 | 引数の説明 |
|---|---|
|
Days (String) |
イベントを保持する日数。この日数よりも古いすべてのイベントは削除されます。 |
|
BatchDelay |
トランザクションが処理できるように SQL を一時停止する時間 (ミリ秒)。 |
|
BatchSize |
各バッチ処理内で影響を受ける行数。 |
Test-AmcRemoveEventsWithId
指定された ID の削除されるイベント数を返します。
戻り値:Void
| 引数 | 引数の説明 |
|---|---|
|
Event Id(String) |
データベースから削除されるイベント ID。 |
|
BatchDelay |
トランザクションが処理できるように SQL を一時停止する時間 (ミリ秒)。 |
|
BatchSize |
各バッチ処理内で影響を受ける行数。 |
Test-AmcRemoveEventsWithIdRange
ID 範囲内の削除される数をイベント数を返します。
戻り値:Void
| 引数 | 引数の説明 |
|---|---|
|
End Event Id (String) |
データベースから削除されるイベント ID の終了範囲。 |
|
Start Event Id (String) |
データベースから削除されるイベント ID の開始範囲。 |
|
BatchDelay |
トランザクションが処理できるように SQL を一時停止する時間 (ミリ秒)。 |
|
BatchSize |
各バッチ処理内で影響を受ける行数。 |
Test-AmcRemoveHighVolumeEventsOlderThan
指定された日数よりも古い大量のイベントである、削除されるイベント数を返します。
戻り値:Void
| 引数 | 引数の説明 |
|---|---|
|
Days (String) |
大量のイベントを保持する最大期間。 |
|
BatchDelay |
トランザクションが処理できるように SQL を一時停止する時間 (ミリ秒)。 |
|
BatchSize |
各バッチ処理内で影響を受ける行数。 |
Test-AmcRemoveOrphanedAlerts
削除される関連付けられたイベントがないアラート数を返します。
戻り値:Void
| 引数 | 引数の説明 |
|---|---|
|
BatchDelay |
トランザクションが処理できるように SQL を一時停止する時間 (ミリ秒)。 |
|
BatchSize |
各バッチ処理内で影響を受ける行数。 |
Update-AmcSchedule
指定されたスケジュール オブジェクトから、単一のスケジュールされたメンテナンスを更新します。このオブジェクトは、Get-AmcSchedule コマンドから取得できます。
更新できるプロパティ:
- 説明
- StartTimeInUTC
- パラメータ
- StartDayOfWeek
- MaxRunHours
- BatchSize
- BatchDelayMs
戻り値:Void
| 引数 | 引数の説明 |
|---|---|
|
Schedule (MaintenanceHelper.SchedulesDto) |
スケジュールされたメンテナンスのパラメータを格納するスケジュール オブジェクト。 |